************

INTRODUCTION

************



This file describes how to set up and use the Python wrapper code with Melissa DATA's AddressObject.


*************

PREREQUISITES
*************



To make use of the AddressObject Python wrapper you will need:



* An installation of a Python. This Wrapper tested with Python 2.3.4



* The Melissa DATA AddressObject library and data files installed.

	Library = libmdAddr.so

	Data Files = mdAddr.dat, mdAddr.nat, mdAddr.str, mdAddr.lic


  These files are installed automatically if you run setup.sh.



You will need to know the location of these items in order to install and run the Python wrapper.



**********************
Wrapper compatibility
**********************

If the provided pre-compiled wrappers are not compatible with your environment, the necessary files for compilation can be found in the 'interfaces' folder of the object's main directory.




*************

Installation

*************



Copy the entire folder that contains this README.txt into a local directory on your computer.





*****

Setup

*****



Open BuildWrapper.sh for editing. Put in the paths to the addr object library
(libmdAddr.so) and the Python include directory.

After the paths have been correctly set,
run BuildWrapper.sh (sh BuildWrapper.sh) and _mdAddrPythonWrapper.so will
be created.
This step must be completed successfully to run the Python sample





************
Dependencies

************



You will need to allow _mdAddrPythonWrapper.so to find libmdAddr.so.
You can do this by:


	1. Set LD_LIBRARY_PATH to the directory containing libmdAddr.so.
 
		ex: export LD_LIBRARY_PATH=/DQT/Current


	or


	2. Copy libmdAddr.so into the directory with _mdAddrPythonWrapper.so.






**************************

Setting up the Sample Code

**************************



Open AddressSample.py for editing. You must set the a license string that you receive from your Melissa Data
sales representative:

	License = "License Here"



and also the path to the AddressObject Data Files:

	DataPath = r"/DQT/Current"





***********************

Running the Sample Code

***********************



Navigate to the directory containing the python wrapper using command line and type:
	python AddressSample.py




*******

Updates

*******



The wrapper does not need to be rebuilt for every update. Simply replace Address Object (libmdAddr.so) and the data files. However, if there is a new method added, you will need to rebuild the wrapper to use that new method.




****

Note

****



Here are some general solutions if you run into problems:



Q. I get an error saying "libmdAddr.so: shared object cannot be opened ."

A. This means that _mdAddrPythonWrapper.so cannot link to libmdAddr.so. Please following one of the steps in the Setup section above.



Q. I get a warning saying "_POSIX_C_SOURCE" has been redefined.

A. This warning does not affect the functionality of the wrapper. However, to
remove this warning, go into mdAddrPythonWrapper.cpp and move
#include<Python.h> from the middle of the file (line 147) to the very top.





COPYRIGHT NOTICE

(C)
2014 Melissa Data Corporation. All rights reserved.
